package com.samphanie.auiu.common.properties;

import lombok.Builder;
import lombok.Data;
import lombok.With;

import java.util.ArrayList;
import java.util.List;

/**
 * @Description: Swagger自定义配置
 * @Author ZSY
 * @createTime 2021/4/19 17:49
 */
@Data
@With
@Builder
public class SwaggerProperties {

    /*** 是否开启swagger */
    // private boolean enabled;
    /*** API文档生成基础路径 */
    private String apiBasePackage;
    /*** group */
    @Builder.Default
    private String groupName = "default";
    /*** swagger会解析的url规则 */
    @Builder.Default
    private List<String> basePath = new ArrayList<>();
    /*** 在basePath基础上需要排除的url规则 */
    @Builder.Default
    private List<String> excludePath = new ArrayList<>();
    /*** 是否要启用登录认证 */
    private boolean enableSecurity;
    /*** 文档标题 */
    @Builder.Default
    private String title = "swagger";
    /*** 文档描述 */
    @Builder.Default
    private String description = "swagger document";
    /*** 文档版本 */
    @Builder.Default
    private String version = "1.0";
    /*** 许可证 */
    @Builder.Default
    private String license = "";
    /*** 许可证URL */
    @Builder.Default
    private String licenseUrl = "";
    /*** 服务条款URL */
    private String termsOfServiceUrl = "https://www.auiucloud.com";
    /*** host信息 */
    @Builder.Default
    private String host = "";
    /*** 文档联系人姓名 */
    private String contactName;
    /*** 文档联系人网址 */
    private String contactUrl;
    /*** 文档联系人邮箱 */
    private String contactEmail;
}
